Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ops: Allow .ddev/config.yaml in repo #4

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ops: Allow .ddev/config.yaml in repo #4

wants to merge 1 commit into from

Conversation

unscripted
Copy link
Member

Changes proposed in this pull request

This PR updates the .gitignore file allowing the config.yaml file to be tracked in the repo.

During the set up of a new site, it was discovered that the config.yaml wasn't tracked. This caused the end user to run through additional (undocumented) steps when setting up their local environment. By tracking the DDEV config file, we ensure the project starts with a consistent environments for all site developers.

Pre-submit checklist

As the author of this pull request, I verify that:

  • I have set the target branch to master.
  • I have detailed the purpose of this Pull Request in a non-technical way.
  • I have detailed how to test the changes in the Pull Request.
  • I have detailed the functional tests required for approval.
  • I have performed a self-review of my code to ensure it is DRY and follows the team's coding standards.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • I have verified that my code does not introduce a debug warning in my local environment.
  • I have verified that the functional tests work in my local environment.
  • I have verified that all automated tests pass or have provided a detailed comment about why I am submitting with a failed pipeline.
  • I have verified that any dependent changes have been merged and published in downstream commits.
  • I have added a link to this Pull Request in the Asana task.
  • I have moved the Asana task to "Ready for Functional Review".
  • I have left a comment in Asana and GitHub tagging a team member with a request for `review.

Testing

How to test the changes in this pull request

Follow the steps below to test the changes in this PR.

  1. Deploy this branch to the dev environment.
  2. Navigate to...

Functional tests

As the functional tester for this pull request, I verify that:

  • It [does something]
  • it does not...
  • As an admin, I can...
  • As a user, I can...

Once testing is complete, notify the author of any failed tests and move the task to "Kick back" in Asana. If all tests pass, move the task to "Ready for Code Review" in Asana and tag a team member for code review.

Code review

As the code reviewer for this pull request, I verify that:

  • All automated tests have passed.
  • The code is written (or documented) in a way that is easy to understand.
  • The code is free of obvious errors.
  • The code is free of obvious duplication.
  • The code follows our coding standards.
  • The code is sanitized or escaped appropriately for any SQL or XSS injection possibilities.

Once testing is complete, notify the author of any failed tests and move the task to "Kick back" in Asana or continue with the "merging" steps below.

Merging

As the individual merging this pull request, I verify that:

  • All automated tests have passed.
  • All functional tests have passed.
  • All code review tests have passed.
  • I have moved the task to "Ready to Deploy" in Asana and notified the pull request author.

Signed-off-by: Cullen Whitmore <cwhitmore@matchboxdesigngroup.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant